<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<title>Migrate Class - Fuel Documentation</title>
	<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
	<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
	<script type="text/javascript" src="../assets/js/nav.js"></script>
	<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
	<script type="text/javascript">
		$(function() {
			show_nav('classes', '../');
		});
		hljs.tabReplace = '    ';
		hljs.initHighlightingOnLoad();
	</script>
</head>
<body>

	<header>
		<h1>Fuel Documentation</h1>
	</header>

	<div id="main-nav"></div>

	<section id="content">
		<h2>Migrate Class</h2>

		<p>The migrate class allows you to run, walk through and revert <a href="../general/migrations.html">Migrations</a> from your controllers.</p>

		<article>
			<h4 id="method_current">current()</h4>
			<p>Runs the up and down methods to the migration currently set in the migration config.</p>
			<table class="method">
				<tbody>
				<tr>
					<th>Static</th>
					<td>Yes</td>
				</tr>
				<tr>
					<th>Parameters</th>
					<td>None</td>
				</tr>
				<tr>
					<th>Returns</th>
					<td>bool</td>
				</tr>
				<tr>
					<th>Example</th>
					<td>
						<pre><code>Migrate::current();</code></pre>
					</td>
				</tr>
				</tbody>
			</table>
		</article>

		<article>
			<h4 id="method_latest">latest()</h4>
			<p>Runs up methods for ever migration between the current version and the last in the migrations folder.</p>
			<table class="method">
				<tbody>
				<tr>
					<th>Static</th>
					<td>Yes</td>
				</tr>
				<tr>
					<th>Parameters</th>
					<td>None</td>
				</tr>
				<tr>
					<th>Returns</th>
					<td>boolean</td>
				</tr>
				<tr>
					<th>Example</th>
					<td>
						<pre><code>Migrate::latest();</code></pre>
					</td>
				</tr>
				</tbody>
			</table>
		</article>

		<article>
			<h4 id="method_version">version($version)</h4>
			<p>The <strong>version</strong> method will move the migrations up or down to set the schema at a specific migration.</p>
			<table class="method">
				<tbody>
				<tr>
					<th>Static</th>
					<td>Yes</td>
				</tr>
				<tr>
					<th>Parameters</th>
					<td>
						<table class="parameters">
							<tr>
								<th>Param</th>
								<th>Default</th>
								<th>Description</th>
							</tr>
							<tr>
								<th><kbd>$version</kbd></th>
								<td><i>required</i></td>
								<td>The version you are migrating to.</td>
							</tr>
						</table>
					</td>
				</tr>
				<tr>
					<th>Returns</th>
					<td>mixed - Dependent on the <var>$return_type</var>.</td>
				</tr>
				<tr>
					<th>Example</th>
					<td>
						<pre class="php"><code>Migrate::version($version)</code></pre>
					</td>
				</tr>
				</tbody>
			</table>
		</article>

	</section>

	<section id="footer">
		<p>
			<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
			&copy; 2010 - 2011 Fuel Development Team
		</p>
	</section>

</body>
</html>